/*
 * Copyright (C) 2017-2019 Dremio Corporation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.dremio.concurrent;

/**
 * A wrapper for Runnables that provides a hook to do cleanup.
 */
public abstract class SelfCleaningRunnable implements Runnable {
  private final Runnable delegate;

  /**
   * Constructor.
   *
   * @param runnable the Runnable to wrap
   */
  public SelfCleaningRunnable(final Runnable runnable) {
    this.delegate = runnable;
  }

  @Override
  public void run() {
    try {
      delegate.run();
    } finally {
      cleanup();
    }
  }

  @Override
  public String toString() {
    return delegate.toString();
  }

  /**
   * Cleanup.
   *
   * <p>Derived classes should put any necessary cleanup in here. This
   * is guaranteed to be called, even if the wrapped Runnable throws an
   * exception.
   */
  protected abstract void cleanup();
}
